home *** CD-ROM | disk | FTP | other *** search
/ Network Supervisor's Toolkit / Network Supervisor's Toolkit.iso / communic / comroute / comroute.txt < prev    next >
Encoding:
Text File  |  1996-07-10  |  20.4 KB  |  719 lines
  1. COMROUTE
  2. A MODEM SHARING PROGRAM 
  3. FOR NOVELL NETWARE IPX 
  4. NETWORKS
  5.  
  6. VERSION 1.00
  7. 11/3/95
  8.  
  9.  
  10. Copyright c 1995 by R J Crowther
  11.  
  12.  
  13.  
  14. TRADEMARKS
  15.  
  16. Netware, Netware Lite, Personal Netware and Novell are 
  17. registered trademarks and IPX is a trademark of Novell, Inc.
  18. Microsoft and MS-DOS are registered trademarks and Windows 
  19. and Windows for Workgroups are trademarks of Microsoft 
  20. Corporation.
  21.  
  22. PKUNZIP is a trademark of PKWARE, Inc.
  23.  
  24.  
  25.  
  26. INTRODUCTION
  27.  
  28. COMROUTE allows a number of workstations attached to a 
  29. Novell network to share a modem or other serial (RS-232) device 
  30. attached to a COM port.
  31.  
  32. Network users are used to the concept of sharing resources : that 
  33. is the fundamental reason for networking. Novell networks 
  34. provide sophisticated facilities for sharing storage devices and 
  35. printers, but not for serial devices such as modems.
  36. The "Novell networks" on which COMROUTE works include all 
  37. those based on the IPX protocol. These include all versions of 
  38. Netware, Netware Lite and Personal Netware.
  39.  
  40. This version of COMROUTE does not include support for 
  41. NETBIOS networks such as Windows for Workgroups. A future 
  42. version of COMROUTE for NETBIOS may be released if there 
  43. is user demand.
  44.  
  45. Most network applications involve the concept of one or more 
  46. "clients" or resource users, and "servers" or resource providers. 
  47. COMROUTE is no different, and has two main parts, OFFER 
  48. which is the server and CAPTURE which is the client. Note that 
  49. neither part runs on a Novell 2.x , 3.x or 4.x file server - both are 
  50. DOS programs which run on workstations.
  51.  
  52. OFFER "takes over" a comms port on the server workstation, 
  53. and allows clients running "CAPTURE" on other workstations to 
  54. connect to it. Each copy of OFFER captures a single comms port, 
  55. and only one client may connect at one time. Both OFFER and 
  56. CAPTURE are Terminate and Stay Resident programs. This 
  57. means that the server workstation (as well as the client) can be 
  58. used as normal while servicing the comms port.
  59.  
  60. Port configuration such as baud rate, number of data bits and so 
  61. on are automatically handled by the programs.
  62.  
  63. A utility program "UTIL" allows the user to display configuration 
  64. and statistics, and to unload OFFER or CAPTURE from 
  65. memory.
  66.  
  67.  
  68.  
  69. INSTALLATION
  70.  
  71. Installing the software is simply a matter of using PKUNZIP to 
  72. extract the files into your preferred directory. PKUNZIP is not 
  73. included as part of the package, but is available as Shareware. 
  74.  
  75. The COMROUTE software makes no assumptions as to the 
  76. location of the files, and they can be loaded on a file server if 
  77. required.
  78.  
  79.  
  80.  
  81. SOFTWARE LICENCE
  82.  
  83. SHAREWARE VERSION
  84.  
  85. You may install and use this software for 60 days for the purpose 
  86. of evaluating it. If you find the software useful you must register 
  87. it, otherwise you must discontinue using it after this period. You 
  88. are encouraged to copy and share this software, but this 
  89. documentation must be included. The software has specific 
  90. limitations set out below.
  91.  
  92. Support is not guaranteed for the Shareware version.
  93. Please support the concept of Shareware by purchasing the 
  94. registered version if you use COMROUTE beyond the evaluation 
  95. period.
  96.  
  97.  
  98. REGISTERED VERSION
  99.  
  100. You are licenced to use this software on a single network. Any 
  101. number of clients may access a single modem or serial port, 
  102. however one licence must be purchased for each shared modem 
  103. or serial port operated simultaneously.
  104.  
  105. Support is available to registered users via post or e-mail. See the 
  106. separate Support section.
  107.  
  108. Free distribution of this version to third parties is not permitted. 
  109. Please note- the registered software is serial-numbered. 
  110. Licence violations across a single LAN are detected by the 
  111. software.
  112.  
  113.  
  114.  
  115. SHAREWARE VERSION LIMITATIONS
  116.  
  117. The shareware version has the following limitations :
  118.  
  119. 1)    The baud rate is limited to 9600. Any higher baud rate 
  120.     which is requested will default to a setting of 9600 baud.
  121.  
  122. 2)    The server will cease to operate after 1 hour - it will 
  123.     disconnect from any active clients, and refuse further 
  124.     connections. The server will also decline to unload, 
  125.     meaning that to re-activate it the server will have to be re-
  126.     booted. The normal operation of the server PC will 
  127.     otherwise be unaffected.
  128.  
  129.  
  130. DISCLAIMER
  131.  
  132. The author does not accept any responsibility for loss or damage, 
  133. direct or consequential, arising from the use of this product, nor 
  134. from the inability to use it for any reason.
  135.  
  136. In any case, the author's liability will be limited to the sum paid 
  137. for the licence to use the product. 
  138.  
  139. QUICK START
  140.  
  141. Here is the quick way to get started :
  142.  
  143. Assuming you have a modem attached to a workstation via a 
  144. serial port connected to COM1: and a fully configured serial 
  145. cable allowing hardware handshaking. The client software will 
  146. emulate COM1.
  147.  
  148. 1)    On the PC with the modem attached (the server) enter
  149.     OFFER -c1 -nModem -fh1
  150.  
  151.     -c1         specifies COM1
  152.     -nModem     sets the server name for this port
  153.     -fh1         enables hardware flow control in 
  154.             RTS/CTS mode
  155.  
  156. 2)    On the PC which is to be the client enter
  157.     CAPTURE -c1 -nModem
  158.  
  159.     -c1        specifies that COM1 is to be 
  160.             emulated
  161.  
  162.     -nModem        sets the server to connect to
  163.  
  164. 3)    On the client PC start and configure your comms software 
  165.     to use INT14 and (in this case) port 1.
  166.  
  167. 4)    Communicate !
  168.  
  169.  
  170.  
  171. GENERAL DESCRIPTION
  172.  
  173. TSR Operation
  174.  
  175. Both OFFER and CAPTURE programs operate as Terminate 
  176. and Stay Resident (TSR) programs in DOS, each occupying 
  177. about 20K of memory. Once each is loaded, it continues to run 
  178. by processing when DOS is idle, allowing other programs to be 
  179. loaded. The Novell client programs (NETX or VLM) operate in 
  180. the same way.
  181.  
  182. OFFER "takes over" the specified serial port on the server 
  183. workstation. Incoming data from the port is sent to a client 
  184. workstation running CAPTURE while data from the client is sent 
  185. to the port.
  186.  
  187. Both OFFER and CAPTURE are Windows compatible.
  188.  
  189.  
  190. Network Communication
  191.  
  192. The communications between OFFER and CAPTURE are 
  193. implemented by sending IPX data packets between the 
  194. workstations. These packets contain data as well as control and 
  195. configuration information (such as the baud rate). 
  196. Note that both OFFER and CAPTURE must be on a single 
  197. network segment, that is no network bridges or routers, or file 
  198. servers acting as bridges, may intervene between the 
  199. workstations. A future version may remove this limitation.
  200.  
  201.  
  202. INT 14 Interface
  203.  
  204. How it works
  205. CAPTURE talks to your communications programs via the INT-
  206. 14 interface. INT-14 is a hang-over from the earlier days of PCs, 
  207. as it is the BIOS interface used to talk to the serial ports. In fact, 
  208. the INT-14 BIOS services proved too slow to be of practical use, 
  209. as they did not use interrupt processing, so most software vendors 
  210. wrote code to directly interface to the serial port hardware. This 
  211. was unfortunate, since the BIOS was supposed to insulate 
  212. programmers from the specifics of the hardware. However, the 
  213. BIOS interface suits our purpose, as INT-14 calls can be 
  214. redirected to a program such as CAPTURE, and this allows the 
  215. "real" serial hardware to be on a different PC altogether. 
  216. Performance is not likely to become a problem, provided the 
  217. network is not overloaded, since Ethernet for example runs at 
  218. least 100 times faster than a PC serial port can.
  219.  
  220. OFFER uses interrupt-driven serial port handlers to ensure that 
  221. high serial data rates can be accommodated without problems. 
  222. For best performance at higher speeds, 16550 FIFO-buffered 
  223. UARTS are fully supported. In most cases even at 19.2k baud, 
  224. COMROUTE performance will be indistinguishable from direct 
  225. hardware connection.
  226.  
  227. Of course, your communications software must support the INT-
  228. 14 BIOS interface to be useable with COMROUTE, but many 
  229. current programs have this option.
  230.  
  231.  
  232. Int 14 Port Number
  233.  
  234. When you start CAPTURE, you specify a port number with the 
  235. "-c" option. The communications program you are using needs to 
  236. be configured to use the same port number.
  237.  
  238. CAPTURE can use any port number between 1 and 9, but not all 
  239. comms software packages do. Since ports 1 to 4 are likely to be 
  240. "real" comms ports on the client PC, it is best to use port 
  241. numbers in the range 5 to 9 provided the comms software 
  242. supports them.
  243.  
  244. As an example, WinCIM has a "LAN" setting in the Session 
  245. settings window when you select Int14 as the comms port.
  246.  
  247.  
  248. Using Windows
  249.  
  250. Both OFFER and CAPTURE are compatible with all versions of 
  251. Windows. In either case, the TSR program must be loaded in 
  252. DOS before Windows is started.
  253.  
  254. OFFER may suffer performance degradation when some 
  255. Windows programs are run. The performance can often be 
  256. improved by changing the "INT28FILTER=" setting in the 
  257. [STANDARD] section of the SYSTEM.INI file to a lower value 
  258. (the default is 10).
  259.  
  260. CAPTURE supports Windows programs which are capable of 
  261. using the INT-14  interface.
  262.  
  263.  
  264. Loading in High Memory
  265.  
  266. Both CAPTURE and OFFER can be loaded in high memory 
  267. above 640K if your 386 memory manager supports this.
  268.  
  269. Flow Control
  270.  
  271. Flow control is the method by which the flow of data between 
  272. serial devices is regulated. This allows devices that can process 
  273. incoming data at different rates to hold up the flow of data until 
  274. they can "catch up". COMROUTE can use four flow control 
  275. modes. Each of the modes is "bi-directional" - OFFER uses flow 
  276. control to prevent its own buffers overflowing and also responds 
  277. to flow control from the connected device.
  278.  
  279. OFFER and CAPTURE have data buffers of the following sizes 
  280. (not configurable) :
  281.  
  282. OFFER transmit buffer (data to port)        :    1024 bytes
  283. OFFER receive buffer (data from port)        :    1024 bytes
  284. CAPTURE receive buffer (data from port)        :    512 bytes
  285. CAPTURE transmit buffer (data to port)        :    256 bytes
  286.  
  287. No flow control :
  288.  
  289. No action is taken if comms buffers overflow, and data 
  290. may be lost. However, this mode may be suitable for 
  291. block data transmission (e.g. XMODEM), where the data 
  292. block size is small enough to fit in OFFER's data buffers.
  293. Software flow control (XON/XOF)
  294. The software sends an XOF to interrupt the flow of 
  295. incoming data when its buffers fill up. It sends an XON to 
  296. restart data flow.
  297. If an XOF is received, no further data is transmitted until 
  298. an XON arrives.
  299.  
  300.  
  301. Hardware flow control (RTS/CTS)
  302.  
  303. The software controls RTS to stop the flow of incoming 
  304. data when its buffers fill up. 
  305. The software reacts to CTS to control the transmission of 
  306. data.
  307. This is the most common form of hardware handshaking, 
  308. and is suitable for use with most modems.
  309.  
  310.  
  311. Hardware flow control (DTR/DSR)
  312.  
  313. The software controls DTR to stop the flow of incoming 
  314. data when its buffers fill up. 
  315. The software reacts to DSR to control the transmission of 
  316. data.
  317.  
  318.  
  319.  
  320. OFFER
  321. Function
  322.  
  323. OFFER is the server program in the COMROUTE package. It 
  324. runs on a PC which has a modem or other serial device attached 
  325. to one of its serial ports. Other PCs (clients) may then attach to 
  326. and utilise this port.
  327.  
  328. OFFER should generally be started before any clients attempt to 
  329. attach to it.
  330.  
  331. Parameters
  332.  
  333. -n<name>    Sets the name by which the port will be known to 
  334.         the network. Up to 16 characters may be used - 
  335.         case is significant.
  336.  
  337.         Default if this parameter is omitted is "Comms".
  338.  
  339. -c<port>    Sets the port number to be utilised. Ports COM1 
  340.         to COM4 may be specified. DOS default settings 
  341.         for port address and IRQ will be used unless 
  342.         specified by the -a and -I parameters.
  343.         The default port if this parameter is omitted is 
  344.         COM1.
  345.  
  346.         Defaults addresses and IRQs are :
  347.  
  348.         COM1        address 3F8, IRQ 4
  349.         COM2        address 2F8, IRQ 3
  350.         COM3        address 3E8, IRQ 4
  351.         COM4        address 2E8, IRQ 3
  352.  
  353. -a<address>    Sets a non-standard port I/O address for this port. 
  354.         <address> is a hex value.
  355.  
  356.         Default if this parameter is omitted is the default 
  357.         address for the specified comms port.
  358.  
  359.  
  360. -i<IRQ>        Sets a non-standard IRQ number for the interrupt 
  361.         on this port.
  362.         Default if this parameter is omitted is the default 
  363.         IRQ number for the specified comms port.
  364.  
  365.  
  366. -f<mode>    Specifies the flow control mode for the port. 
  367.  
  368.         Possible values are :
  369.  
  370.         -fn    No flow control
  371.         -fs    XON/XOF flow control
  372.         -fh1    RTS/CTS flow control **
  373.         -fh2    DTR/DSR flow control
  374.  
  375.         Default if this parameter is omitted is "no flow 
  376.         control".
  377.  
  378.         ** RTS/CTS flow control is recommended for 
  379.         use with most modems.
  380.  
  381.  
  382. CAPTURE
  383. Function
  384.  
  385. CAPTURE is the client program in the COMROUTE package. It 
  386. runs on a PC which has communications software that can be 
  387. configured to use INT14.
  388.  
  389. CAPTURE locates servers by polling for them. If you specify a 
  390. server using the -n option, CAPTURE will search for that server. 
  391. If the server is not specified or not found, CAPTURE will load 
  392. but will not connect until UTIL is used to specify a connection.
  393. Note that you can set the flow control used by the server when 
  394. loading CAPTURE. This is to allow multiple clients to use 
  395. different flow-control modes if required.
  396.  
  397. Parameters
  398. -n<name>    Sets the name of the server to connect to.
  399.  
  400.         Default if this parameter is omitted is to load but 
  401.         not to connect to a server.
  402.  
  403. -c<port>    Sets the port number to be emulated by 
  404.         CAPTURE. Can be in the range 1 to 9.
  405.         Default if this parameter is omitted is port 1.
  406.  
  407. -f<mode>    Specifies the flow control mode for the server 
  408.         port. Possible values are :
  409.  
  410.         -fn    No flow control
  411.         -fs    XON/XOF flow control
  412.         -fh1    RTS/CTS flow control **
  413.         -fh2    DTR/DSR flow control
  414.  
  415.         Default if this parameter is omitted is "no flow 
  416.         control".
  417.  
  418.         ** RTS/CTS flow control is recommended for 
  419.         use with most modems.
  420.  
  421.  
  422.  
  423.  
  424. UTIL
  425.  
  426. UTIL is a program which contains display and utility functions 
  427. for both OFFER and CAPTURE.
  428.  
  429. Its functions are all started by command line options.
  430.  
  431. Unload CAPTURE / OFFER from memory
  432.  
  433.     Syntax     : UTIL -u
  434.     Applies to     : CAPTURE and OFFER
  435.  
  436.     This function unloads CAPTURE or OFFER from memory, 
  437.     provided that no other TSRs have been loaded after them. If 
  438.     necessary, a disconnection is also performed.
  439.  
  440. Disconnect Client from Server
  441.  
  442.     Syntax     : UTIL -d
  443.     Applies to     : CAPTURE and OFFER
  444.  
  445.     This function disconnects (breaks) the link between CAPTURE 
  446.     and OFFER. Another client may then connect. Note that the 
  447.     disconnection may be made at either the client or the server.
  448.  
  449. Display Configuration
  450.  
  451.     Syntax     : UTIL -c
  452.     Applies to     : OFFER
  453.  
  454.     This function displays the configuration of the server.
  455.  
  456. Display Configuration continuously
  457.  
  458.     Syntax     : UTIL -C
  459.     Applies to     : OFFER
  460.  
  461.     This function displays the configuration of the server, refreshing 
  462.     regularly. Press Escape to stop the display.
  463.  
  464. Display Statistics
  465.  
  466.     Syntax     : UTIL -s
  467.     Applies to     : CAPTURE and OFFER
  468.  
  469.     This function displays statistics relating to IPX and serial 
  470.     communications.
  471.  
  472. Display Statistics Continuously
  473.     Syntax     : UTIL -S
  474.     Applies to     : CAPTURE and OFFER
  475.  
  476.     This function displays statistics relating to IPX and serial 
  477.     communications, refreshing regularly. Press Escape to stop the 
  478.     display.
  479.  
  480. Change Flow-Control Mode
  481.  
  482.     Syntax        : UTIL -f<mode>
  483.     Applies to     : CAPTURE and OFFER
  484.  
  485.     Possible values of <mode> are :
  486.  
  487.         -fn    No flow control
  488.         -fs    XON/XOF flow control
  489.         -fh1    RTS/CTS flow control **
  490.         -fh2    DTR/DSR flow control
  491.  
  492.         ** RTS/CTS flow control is recommended for 
  493.         use with most modems.
  494.  
  495. Poll for Servers and select connection
  496.  
  497.     Syntax        : UTIL -p
  498.     Applies to     : CAPTURE
  499.  
  500.     This function searches for all servers (copies of OFFER) visible 
  501.     on the network and lists them. The user can then select one to 
  502.     connect to.
  503.  
  504. Poll for Servers and make connection
  505.  
  506.     Syntax        : UTIL -P<name>
  507.     Applies to     : CAPTURE
  508.  
  509.     This function searches for all servers (copies of OFFER) visible 
  510.     on the network. If the server specified by <name> is found, it is 
  511.     connected to. 
  512.  
  513.  
  514.  
  515. ERROR MESSAGES
  516.  
  517. CAPTURE
  518.  
  519. Error-CAPTURE already installed
  520.  
  521.     CAPTURE is already resident in memory. CAPTURE 
  522.     will not be re-loaded.
  523.  
  524.     No servers detected
  525.     A poll failed to discover any servers on the network. 
  526.     CAPTURE will still be loaded, but will remain inactive 
  527.     until at least one server is available. Connection can then 
  528.     be made using UTIL -p or UTIL -P to poll for servers 
  529.     again.
  530.  
  531. Error-Invalid parameter
  532.  
  533.     An invalid command-line parameter was entered. Please 
  534.     correct the parameter and try again.
  535.  
  536. Error-IPX support not present
  537.  
  538.     IPX support is not currently loaded. Please refer to your 
  539.     network software manuals.
  540.  
  541. Error-IPX error code
  542.  
  543.     An IPX processing or communications error was 
  544.     detected. The error number is displayed. See separate list 
  545.     for codes.
  546.  
  547. Fatal-out of memory
  548.  
  549.     The program ran out of heap. Please report this error if 
  550.     encountered.
  551.  
  552.  
  553.  
  554. OFFER
  555.  
  556. OFFER is already installed
  557.  
  558.     OFFER is already resident in memory. OFFER will not 
  559.     be re-loaded.
  560.  
  561. Fatal : error allocating memory
  562. Fatal : out of memory
  563.  
  564.     The program ran out of heap. Please report this error if 
  565.     encountered.
  566.  
  567. Error-Invalid parameter
  568.  
  569.     An invalid command-line parameter was entered. Please 
  570.     correct the parameter and try again.
  571.  
  572. Fatal comms open error
  573.  
  574.     A fatal error was encountered opening the comms port. 
  575.     An error number is displayed. See separate list for codes. 
  576.  
  577. Error-IPX support not present
  578.  
  579.     IPX support is not currently loaded. Please refer to your 
  580.     network software manuals.
  581.  
  582. Error-IPX error code
  583.  
  584.     An IPX processing or communications error was 
  585.     detected. The error number is displayed. See separate list 
  586.     for codes.
  587.  
  588. Licence violation detected
  589. Operation suspended
  590.  
  591.     More than one copy of OFFER with the same serial 
  592.     number was detected on the network. Please unload all 
  593.     extra copies.
  594.  
  595. Shareware version time-out 
  596. Operation suspended 
  597.  
  598.     The one-hour time limit on the shareware version has 
  599.     been reached. It will be necessary to re-boot the server to 
  600.     continue using COMROUTE.
  601.  
  602.  
  603. UTIL
  604.  
  605.  
  606. OFFER or CAPTURE are not currently installed
  607.  
  608.     OFFER or CAPTURE are not loaded. Please load one of 
  609.     them before running UTIL.
  610.  
  611. -c option is not valid for CAPTURE
  612.  
  613.     The -c option only applies to OFFER, which is not loaded 
  614.     on this PC.
  615.  
  616. -p option is not valid for OFFER
  617.  
  618.     The -p option only applies to CAPTURE, which is not 
  619.     loaded on this PC.
  620.  
  621. ** FATAL : Invalid parameter
  622.  
  623.     An invalid command-line parameter was entered. Please 
  624.     correct the parameter and try again.
  625.  
  626. Error - can't unload OFFER due to TSR installed after it
  627. Error - can't unload CAPTURE due to TSR installed after it
  628.  
  629.     Another TSR program has been installed after OFFER or 
  630.     CAPTURE. It is not possible to unload at this time.
  631.  
  632. Unload request denied
  633.  
  634.     OFFER declined to unload, because of shareware time-
  635.     out or licence violation detected.
  636.  
  637. Already connected to server
  638.  
  639.     using UTIL -d before polling for servers.
  640.  
  641. No servers located - cannot connect
  642.  
  643.     Polling failed to locate any available servers on the 
  644.     network. If servers are present, they may already be 
  645.     connected to another client.
  646.  
  647.  
  648.  
  649. REGISTRATION
  650.  
  651. Please support the Shareware concept by registering this program 
  652. if you find it useful.
  653.  
  654. Registering COMROUTE will bring the following benefits :
  655.  
  656.     1)    Printed manual (if delivered by mail)
  657.     2)    Latest registered version of COMROUTE will be 
  658.         delivered.
  659.     3)    The next major version of COMROUTE will be delivered 
  660.         to you free of charge.
  661.     4)      Support will be given via e-mail or post.
  662.  
  663. Registration costs £ 40 sterling or $ 60 US. You may register by 
  664. the following means :
  665.  
  666. 1)    By post to :
  667.  
  668.     Mr R J Crowther
  669.     20, Howe Road
  670.     Haverhill
  671.     Suffolk
  672.     CB9 9NJ
  673.     England
  674.  
  675.     Please send either a personal cheque in sterling, or a 
  676.     money order for $ US. If you have no alternative, send 
  677.     notes/bills. All payments are sent at the sender's risk. 
  678.     Other forms of payment are not accepted at present. 
  679.     Please ask if you have a problem with these forms of 
  680.     payment.
  681.  
  682. 2)    On CompuServe, through the SWREG forum. This 
  683.     facility may not be available immediately, so please be 
  684.     patient.
  685.  
  686. SUPPORT
  687.  
  688. I will support registered users in the following ways :
  689.  
  690. 1)    By e-mail
  691.  
  692.     Please mail your queries to me via 100255,660 on 
  693.     Compuserve, or via the Internet to
  694.     100255,660@COMPUSERVE.COM
  695.  
  696. 2)    By post to :
  697.     Mr R J Crowther
  698.     20, Howe Road
  699.     Haverhill
  700.     Suffolk
  701.     CB9 9NJ
  702.     England
  703.  
  704. SUPPORT TO SHAREWARE USERS 
  705.  
  706. I may be able to help Shareware users, provided queries are sent 
  707. by e-mail only. Time may limit the amount of support given to 
  708. Shareware users - to obtain full support please register !
  709.  
  710.  
  711. Release History
  712.  
  713. Version 1.00    Beta release 11/03/95
  714.  
  715.  
  716.  
  717.  
  718.  
  719.